home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ShareWare OnLine 2
/
ShareWare OnLine Volume 2 (CMS Software)(1993).iso
/
database
/
pdxdoc.zip
/
PDXDOC.DOC
< prev
next >
Wrap
Text File
|
1993-03-05
|
11KB
|
210 lines
/////////////////////////////////////////////////////////////////////
Paradox Documentation Utility - PDXDOC Version 1.0
Steve M. England
3113 Greenhill Drive
Huntsville, Alabama 35810
/////////////////////////////////////////////////////////////////////
This product is the public domain release. It may be shared and
passed among friends as freely as desired. Users of this product
are encouraged to register with the author to receive the complete
PDXDOC Utility, which includes enhanced features and reporting
capability. These features include the ability to document and
report on program libraries, enhanced system reports including
Paradox "family" statistics and more. Users must have either
Paradox 4.0 or the Runtime version of Paradox 4.0 to utilize this
utility. A DOS executable is in the works and should be released
sometime in the summer of 1993.
The purpose of developing this product was to have a mechanism of
tracking table definitions and statistics for a developed system.
Being a Paradox and 'C' developer, I have often developed multiple
systems and desired to have a means of documenting the database
objects used by my developments. In addition, I desired to have this
documentation presented in such a form as to easily store in my system
development notebooks and folders.
The ensuing result is PDXDOC. This utility will "read" Paradox table
structures and store them in a master description table when added,
and allow the user to update, edit and even delete these tables when
desired. Tables belonging to multiple development efforts can be
tracked painlessly by using a system/project keyword. Reports can
then be generated for the project table listings and the table
descriptions themselves. The structure of the program is quite
simple to follow. The following provides a short overview of the
programs menu function.
┌───── PDXDOC - Main Menu ─────┐
│ 1. Catalog Functions │
├──────────────────────────────┤
│ 2. Report Functions │
├──────────────────────────────┤
│ 3. Set Working Directory │
├──────────────────────────────┤
│ 4. Exit │
└──────────────────────────────┘
1.0 CATALOG FUNCTIONS
The software is available for immediate use once run from the
Paradox environment. Upon selecting the first option, the user is
presented with the choice of adding a table to the catalog, editing
a table already in the catalog, deleting a table from the catalog,
or updating an existing table within the catalog.
1.1 Adding Tables
When this option is selected, PDXDOC presents a dialog box listing
the possible tables that can be added in the current working directory.
(Should the user desire to add a table in a different directory, choose
the 3rd menu item from the main menu to set the working directory to the
desired location.) Upon selecting a table, PDXDOC presents a form
with the table name, project name, table description and table purpose
fields.
The project name field is an optional field, but it is highly suggested
that if the user wishes to keep track with tables over a variety of
projects that he assign the project a general title name. For example,
if the project dealt with ABC Company Personnel Database development,
a suggested name might be ABC Personnel. Then, each table added that
belongs to this project would be ordered, or categorized as a part of
the development. Then, other projects could also be added, making
PDXDOC a more verstile utility.
The table description field is intended to allow users to spell out the
full table name associated with a table. For example, the Paradox
table name used by most developers is too small, being only 8 characters
in length. Therefore a user could have a table PURREQTR and not always
easily recognize that its actual name is Purchase Requisition
Transactions table.
Finally, the table purpose is for the general description of the tables'
purpose within the project, describing its function in the overall
schema. This field is optional.
Once these items are entered, PDXDOC accesses the information for the
table and catalogs it automatically. When the operation is completed,
the user is returned to the main menu. The speed with which the system
operates is highly dependent upon the memory the users system contains.
For example, systems with the minimum 2-megabytes of memory required
by Paradox will find the operation to be somewhat slow, while users whose
systems contain 4-megabytes or more of RAM will be quite pleased with the
speed with which tables are cataloged.
1.2 Editing Cataloged Tables
Once a table has been cataloged, the user has the option of reviewing
and editing the table entries as desired. Upon selection of this option
PDXDOC provides the user with a list of the currently cataloged tables
in the system. Selecting one will bring up a form containing the
information collected and stored for that table.
The form is subdivided into two parts. The upper portion deals with
the master table descriptions itself, similar to the items seen when
adding new tables to the system. The lower portion (accessed by pressing
the F3 function key) contains the tables' column definitions and formats.
Notice that an additional column exists here which allows the user to
provide a more detailed description of each column in a table beyond that
provided for in the column name itself. This allows enhanced documenting
for the tables' columns in future references. Note that this column
is optional, and data is not required to be listed here for reporting
purposes (explained later in the reports section).
Pressing F2 (Do_It!) will return the user to the main menu.
1.3 Deleting A Cataloged Table
There may be a requirement at some time to delete a table from the
catalog completely and remove it from the PDXDOC system. This is provided
for in this option. Upon selection the user is presented with a list
of the tables currently cataloged within the system. Selecting one
removes it from the catalog.
1.4 Updating A Cataloged Table
There may come a time when a table structure is changed during development
thus leaving its cataloged structure out-of-date. Normally a user would
probably think of deleting the table from the catalog and then just
re-adding it to the system. Although this would work without problem, it
would be quite a waste if the user had entered descriptions for each of
columns found in the table definitions cataloged. These descriptions
would then have to be re-entered again.
The update function solves this problem to some extent for the user.
When selected, the user is given a list of the available tables in his
current directory. Once chosen, PDXDOC verifies it has already been
cataloged. If not, the user is informed so and the operation is aborted.
If found, however, then the user is re-presented the initial information
screen to allow any updates or changes to the table descriptions as may
be needed. Pressing <F2> will then allow PDXDOC to update the table into
the catalog.
The update process first loads all of the column information found within
the new table. Then, a comparison is made with the old column titles
with those found in the new cataloged structure. When column names match,
the old descriptions are copied and assigned to the new column
descriptions. Thus, any unchanged column names will retain their
'extended' descriptions. Any new columns added to the table will have
blank extended descriptions; however, the user may edit the catalog and
add descriptions to these columns at any time.
2.0 Reporting Functions
The PDXDOC system provides two levels of reporting capabilities. One
level consists of tables at the system level; the second consists of
table and column definitions.
2.1 System Reports
System Reports generate information concerning the tables belonging to a
project. They do not include the table column definitions and their
respected formats. When selected, the user is provided the option to
generate the report for all projects, or for a specific project. All
tables associated with a project that are cataloged and documented are
then generated to a report listing.
2.2 Table Reports
Table reports provide information concerning the tables themselves: the
column descriptions, field types, width and more. Three options are
available. Selecting all tables will generate the report for all
tables in the system catalog. Selecting the project option allows
all tables associated with a specific project to be reported, and
selecting the single table option allows the report to be generated for
a single table only.
Each report has two an option for two types of output. The first type
provides a report format that does not include the extended descriptions
available for the user to enter when edit a cataloged table. The second
type provides a report that does include these descriptions in the
output.
3.0 Conclusion
As stated earlier, PDXDOC is a utility developed by the author to assist
in tracking the system objects (elements) associated with a development.
The public domain release of this project has been tested and believed
to be error free and complete. Preparations are underway to continue
enhancing this product, and your suggestions would be welcome. The
shareware version of this product is currently in beta testing, and a
DOS executable version is planned for release sometime in the summer of
1993 (thus allowing the functions to be performed without dependence on
the Paradox software). Any questions, suggestions, hints and/or
complaints (surely no complaints...???) should be directed to the address
provided on the first page of this document.
Please make note that Paradox is a registered trademark of Borland
International and compliance is made with all rights and priviledges
thereof.